org.eclipse.vtp.framework.interactions.voice.vxml
Class Catch

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.EventHandler
          org.eclipse.vtp.framework.interactions.voice.vxml.Catch

All Implemented Interfaces:

VXMLConstants

Direct Known Subclasses:

Error

public class Catch
extends EventHandler

The Catch class can be used to handle any error or event type. It is typically employed to implement user defined events and errors. Though it can be used to intercept the "nomatch" and "noinput" events, these should be handled by the dedicated element types NoMatch and NoInput respectively.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

protected java.lang.String

eventName The name of the event or error to catch.

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Catch(java.lang.String eventName)
Creates a new instance of Catch that will be executed when the event or error named by the eventName argument is generated during call processing.

Catch(java.lang.String eventName, int count)
Creates a new instance of Catch that will be executed when the count^th occurrence of the event or error named by the eventName argument is generated during call processing.

Catch(java.lang.String eventName, java.lang.String condition)
Creates a new instance of Catch that will be executed when the event or error named by the eventName argument is generated during call processing and the expression in the condition evaluates to true.

Catch(java.lang.String eventName, java.lang.String condition, int count)
Creates a new instance of Catch that will be executed when the count^th occurrence of the event or error named by the eventName argument is generated during call processing and the expression in the condition evaluates to true.

Method Summary

java.lang.String	getEventName() Returns the name of the event or error to catch.
void	setEventName(java.lang.String eventName) Sets the name of the event or error to catch.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this handler to the supplied set.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.voice.vxml.EventHandler

addAction, addIfClause, getActionsAndIfClauses, getCondition, getCount, removeAction, removeIfClause, setCondition, setCount, writeActionsAndIfClauses

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

eventName

protected java.lang.String eventName

The name of the event or error to catch.

Constructor Detail

Catch

public Catch(java.lang.String eventName)
      throws java.lang.IllegalArgumentException,
             java.lang.NullPointerException

Creates a new instance of Catch that will be executed when the event or error named by the eventName argument is generated during call processing.

Parameters:

eventName - The name of the event or error to catch.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

java.lang.NullPointerException - If the supplied event name is null.

Catch

public Catch(java.lang.String eventName,
             int count)
      throws java.lang.IllegalArgumentException,
             java.lang.NullPointerException

Creates a new instance of Catch that will be executed when the count^th occurrence of the event or error named by the eventName argument is generated during call processing.

Parameters:

eventName - The name of the event or error to catch.

count - Specifies which occurrence of the event to catch.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

java.lang.NullPointerException - If the supplied event name is null.

Catch

public Catch(java.lang.String eventName,
             java.lang.String condition)
      throws java.lang.IllegalArgumentException,
             java.lang.NullPointerException

Creates a new instance of Catch that will be executed when the event or error named by the eventName argument is generated during call processing and the expression in the condition evaluates to true.

Parameters:

eventName - The name of the event or error to catch.

condition - An expression that evaluates to a boolean that determines whether or not this catch element will execute.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

java.lang.IllegalArgumentException - If the supplied condition is empty.

java.lang.NullPointerException - If the supplied event name is null.

Catch

public Catch(java.lang.String eventName,
             java.lang.String condition,
             int count)
      throws java.lang.IllegalArgumentException,
             java.lang.NullPointerException

Creates a new instance of Catch that will be executed when the count^th occurrence of the event or error named by the eventName argument is generated during call processing and the expression in the condition evaluates to true.

Parameters:

eventName - The name of the event or error to catch.

condition - An expression that evaluates to a boolean that determines whether or not this catch element will execute.

count - Specifies which occurrence of the event to catch.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

java.lang.IllegalArgumentException - If the supplied condition is empty.

java.lang.NullPointerException - If the supplied event name is null.

Method Detail

getEventName

public java.lang.String getEventName()

Returns the name of the event or error to catch.

Returns:

The name of the event or error to catch.

setEventName

public void setEventName(java.lang.String eventName)
                  throws java.lang.IllegalArgumentException,
                         java.lang.NullPointerException

Sets the name of the event or error to catch.

Parameters:

eventName - The name of the event or error to catch.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

java.lang.NullPointerException - If the supplied event name is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Description copied from class: EventHandler

Write the attribute members of this handler to the supplied set.

Overrides:

writeAttributes in class EventHandler

Parameters:

attributes - The attribute set to write to.